/**********************************************************************
 *** *                                                            * ***
 *** *  Copyright (c) 2013 Harmonia Holdings Group LLC            * ***
 *** *                                                            * ***
 *** * Permission is hereby granted to use, modify, copy, and     * ***
 *** * distribute this software and its documentation for any     * ***
 *** * purpose only without profit, provided that the above       * ***
 *** * Copyright Notice appears in all copies and that both the   * ***
 *** * Copyright Notice and this Permission Notice appears in     * ***
 *** * every copy of supporting documentation.  No title to nor   * ***
 *** * ownership of the software is transferred hereby.  The name * ***
 *** * of Harmonia Holdings Group LLC shall not be used in        * ***
 *** * advertising or publicity related to the distribution of    * ***
 *** * the software without specific, written, prior permission.  * ***
 *** * This software is provided as-delivered without expressed   * ***
 *** * or implied warranty.  Harmonia Holdings Group LLC          * ***
 *** * makes no representation about the suitability of this      * ***
 *** * software for any purpose and accepts no responsibility for * ***
 *** * its use.                                                   * ***
 *** *                                                            * ***
 *** ************************************************************** ***
 *** *                                                            * ***
 *** * This program is free software; you can redistribute it     * ***
 *** * and/or modify it under the terms of the GNU General Public * ***
 *** * License as published by the Free Software Foundation;      * ***
 *** * either version 2 of the License, or (at your option) any   * ***
 *** * later version.                                             * ***
 *** *                                                            * ***
 *** * This program is distributed in the hope that it will be    * ***
 *** * useful, but WITHOUT ANY WARRANTY; without even the implied * ***
 *** * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR    * ***
 *** * PURPOSE.  See the GNU General Public License for more      * ***
 *** * details.                                                   * ***
 *** *                                                            * ***
 *** * You should have received a copy of the GNU General Public  * ***
 *** * License along with this program; if not, write to the Free * ***
 *** * Software Foundation, Inc., 51 Franklin Street, Fifth       * ***
 *** * Floor, Boston, MA 02110-1301, USA.                         * ***
 *** *                                                            * ***
 *** * For more information: http://www.gnu.org/licenses/gpl.html * ***
 *** *                                                            * ***
 **********************************************************************/
package org.etexascode.interrep.datamodel;

/**
 * Vehicle Speed Commands.
 * @author jrutherford
 */
public class VehicleSpeedCommand extends VehicleCommand
{
	/** Serial ID. */
	private static final long serialVersionUID = -6631923769198842677L;
	
	/** Vehicle Operations (Number corresponds to VMS message value.) */
	public static final int MAX_ACCELERATE_TO_XX = 1;
	public static final int MAX_DECELERATE_TO_XX = 2;
	public static final int NORMAL_ACCELERATE_TO_XX = 3;
	public static final int NORMAL_DECELERATE_TO_XX = 4;
	
	/** The vehicle speed. */
	private double speed;
	
	
	/** Constructor. */
	public VehicleSpeedCommand() { }
	
	/**
	 * Constructor.
	 * @param vehicleID The vehicle ID.
	 * @param commandID The command to perform. (Constants Above)
	 * @param speed The new vehicle speed.
	 */
	public VehicleSpeedCommand(int vehicleID, int commandID, double speed) {
		super(vehicleID, commandID);
		if(commandID != MAX_ACCELERATE_TO_XX && commandID != MAX_DECELERATE_TO_XX &&
			commandID != NORMAL_ACCELERATE_TO_XX && commandID != NORMAL_DECELERATE_TO_XX)
			throw new IllegalStateException("Invalid Vehicle Speed Command.");
		this.speed = speed;
	}
	
	/**
	 * Gets the vehicle speed. 
	 * @return The vehicle speed.
	 */
	public double getSpeed() { return speed; }
}